Index

api/v1/cardfiles/{cardno}/contacts

Path: api/v1/cardfiles/{cardno}/contacts

This API is JSON:API compliant.

This endpoint supports the following methods:
GET POST PATCH DELETE

The resource type for this endpoint is CardFileContact
The identifier is contno

The CardFileContact resource type attributes are as follows:

{
"contNo":integer (read-only)
"title":string
"firstName":string
"middleName":string
"lastName":string
"displayName":string
"jobTitle":string
"department":string
"dob":string
"isPrimary":boolean (read-only)
"details": [{
"type":string
"value":string
"comments":string
}]
"webAccount":{
Flag to indicate if the web logon is enabled. If omitted on creates the account will be enabled.
optional
"enabled":boolean
The logon id for the contact must be unique.
"logonId":string
If not provided Jim2 will automatically generate a password for the contact.
optional
"password":string
}
}